Execute a remote operation or command on a specific node

Request

Sends an event to the node and optionally waits for its response. Use the dedicated event endpoints (e.g. /node/{nodeID}/trigger/gateway-routes) for documented events with typed request and response schemas.

For event=bgp, the backend currently supports:

action: get — return BGP runtime status, peer sessions, learned routes, rejected routes, and advertised prefixes
action: restart — restart the BGP service on the node

Add ?wait=1 to block until the node responds (useful for synchronous checks).

All services require either nodes::remote-execute or nodes::service:{event} permission.

Security

JWTAuthorizer

Path

nodeIDstringrequired

Node ID

eventstringrequired

Event name to trigger on the node. This parameter is open-ended; the backend may support additional event names beyond those with dedicated endpoints.

Example:gateway-routes

Query

waitinteger

Pass 1 to block until the node responds and return its output. Omit for fire-and-forget.

Value:1

Bodyapplication/json

Any of:

Request body used when {event} is set to a container service name and you want to start or stop that service.

cmd_actionstringrequired

Container service action to execute

Enum:"start""stop"

namestring

Optional container service name echoed by some clients

Example:"mycontainer"

curl -i -X POST \
  'https://apidocs.trustgrid.io/_mock/node/{nodeID}/trigger/gateway-routes?wait=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cmd_action": "start",
    "name": "mycontainer"
  }'

Responses

OK

Bodyapplication/json

Any of:

boolean

Response

true